BOT UX API

(0 reviews)

Get RealTimeBalances 3.9

GET /services/{serviceNo}/realTimeBalances

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[localhost]:[port]/bot-ux/{version}/{businessId}/services/{serviceNo}/realTimeBalances

URI Parameter

Name	Type	Description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	M
serviceNo	string	Service number or subscriber number	M

Query Parameter

Name	Type	Description	required
accountNo	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	M (only using for /v1)
dataBalancesOnly	Boolean	Indicates whether to load only data balances in the response.	O (only using for /v1)

Headers

Name	Type	Description	required
Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.`</br>`Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b `</br>`	O
lob	String	TheLine of Business Identifier currently available are:`<br>`Enum: PREPAID , POSTPAID, FIXED`<br>`	M

Security Headers

Name	Type	Description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	M
client_secret	string	Password associated with the client_id. Minimum characters: 5	M

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - listUsageConsumption request processed successfully, response body contains an entity corresponding to the requested resource.

CWC Success Response

{
  "accountNo": 190071170000,
  "sourceBSS": "LIBERATE",
  "serviceNo": "13459170552",
  "balances": [
      {
        "categoryName": "Data 3MB",
        "allowanceAmount": 100.12,
        "allowanceUnit": "MB",
        "rolloverAmount": 10.23,
        "rolloverUnit": "MB",
        "totalAllowanceAmount": 110.35,
        "totalAllowanceUnit": "MB",
        "chargesAmount": 50.42,
        "chargesUnit": "MB",
        "overageAmount": 20.23,
        "overageUnit": "MB",
        "overageCharge": 10.45,
        "balanceAmount": 60.56,
        "balanceUnit": "MB",
        "expiryDate": "2017-09-20T00:00:00-05:00"
      }
    ]
}